Skip to content

fix: updated README.md format from freezed: to freezed:freezed: #1316

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: updated README.md format from freezed: to freezed:freezed: #1316

wants to merge 1 commit into from

Conversation

@arowolojoshuao
Copy link

@arowolojoshuao arowolojoshuao commented Oct 28, 2025 •
edited by coderabbitai bot
Loading

Description

Fixes incorrect build.yaml configuration format in documentation examples.

Changes Made

  • Updated build.yaml configuration from freezed: to freezed:freezed: in all documentation examples
  • Fixed example build.yaml files throughout the repository
  • Updated README.md and translation files to reflect correct configuration format

Fixes

Closes #1309

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Documentation update

Summary by CodeRabbit

  • Documentation

    • Updated build configuration examples across multiple language READMEs to reflect the correct builder namespace reference format.

  • Chores

    • Updated example build configurations to use the qualified builder reference.
    • Added file exclusion to generated code configuration in freezed_lint example.

@coderabbitai
Copy link

coderabbitai bot commented Oct 28, 2025 •
edited
Loading

Walkthrough

Update build.yaml builder references from freezed to freezed:freezed across README documentation files and example build configurations to reflect the correct qualified builder identifier for the build system.

Changes

Cohort / File(s) Summary
Main package documentation
packages/freezed/README.md		 Updated three build.yaml configuration examples (unionKey/unionValue, genericArgumentFactories, and format sections) to use freezed:freezed builder key instead of freezed
Example build configurations
packages/freezed/example/build.yaml, packages/freezed_lint/example/build.yaml		 Updated builder key from freezed to freezed:freezed in the targets.$default.builders section; additionally added lib/missing_private_empty_ctor.dart to generate_for.exclude list in freezed_lint example
Translation documentation
resources/translations/ja_JP/README.md, resources/translations/ko_KR/README.md, resources/translations/vi_VN/README.md, resources/translations/zh_CN/README.md		 Each updated three build.yaml configuration examples within documentation to use qualified builder key freezed:freezed instead of freezed

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • All changes follow an identical, repetitive pattern across multiple files
  • Documentation and configuration updates only—no functional code modifications
  • Straightforward string replacements in build configuration examples

Possibly related PRs

Suggested reviewers

  • rrousselGit

Poem

🐰 A builder name, now crystal clear,
With colon doubled, hope draws near!
From freezed to freezed:freezed we go,
Through docs and configs—the fix will flow! ❄️

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
Out of Scope Changes Check ❓ Inconclusive The majority of changes are directly in scope, updating the builder key format from freezed: to freezed:freezed: across documentation and example files as required by issue #1309. However, in packages/freezed_lint/example/build.yaml, there is an addition to the generate_for.exclude list that gains the entry lib/missing_private_empty_ctor.dart. This change is not mentioned in the PR description and is not directly related to the builder key format update that defines the main scope of the pull request. This addition requires clarification to determine whether it is a necessary correction to the example or an unintended inclusion. Please clarify whether the addition of lib/missing_private_empty_ctor.dart to the exclude list in packages/freezed_lint/example/build.yaml is intentional and related to this fix, or if it was included inadvertently. If this change is necessary for the example to function correctly with the updated builder configuration, it should be documented in the PR description to clarify its scope.
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The PR title "fix: updated README.md format from freezed: to freezed:freezed:" accurately describes the primary objective of the changes. It clearly communicates that the fix involves updating configuration format from the incorrect freezed: to the correct freezed:freezed: format. While the title specifically mentions README.md, the changes also include updating example build.yaml files and translation documentation, all of which are part of the same core fix. The title is concise, clear, and specific enough for a developer scanning the history to understand the main change.
Linked Issues Check ✅ Passed The pull request successfully addresses the requirements specified in linked issue #1309. The changes update build.yaml configuration examples from the incorrect freezed: format to the correct freezed:freezed: format across all relevant files, including packages/freezed/README.md, packages/freezed/example/build.yaml, packages/freezed_lint/example/build.yaml, and translation README files in multiple languages (ja_JP, ko_KR, vi_VN, zh_CN). These changes directly align with the issue's objective to correct configuration documentation and examples to reflect the proper namespace for project-wide configuration.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 541eeab and 56221bf.

📒 Files selected for processing (7)
  • packages/freezed/README.md (3 hunks)
  • packages/freezed/example/build.yaml (1 hunks)
  • packages/freezed_lint/example/build.yaml (1 hunks)
  • resources/translations/ja_JP/README.md (3 hunks)
  • resources/translations/ko_KR/README.md (3 hunks)
  • resources/translations/vi_VN/README.md (3 hunks)
  • resources/translations/zh_CN/README.md (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: freezed (packages/freezed, stable, get)
🔇 Additional comments (8)
packages/freezed_lint/example/build.yaml (2)

4-4: Configuration update: builder namespace qualified correctly.

The builder identifier has been updated from freezed: to freezed:freezed:, aligning with the correct qualified namespace for the Freezed builder in the build system. This change is consistent with pub.dev documentation and applied across all build.yaml examples in the repository.

8-8: Additional configuration: new exclusion added to generate_for list.

The file now excludes lib/missing_private_empty_ctor.dart from code generation. This change is orthogonal to the builder namespace update and appears to be a separate improvement to the linting example configuration.

packages/freezed/example/build.yaml (1)

4-4: Configuration update: builder namespace aligned with specification.

The builder reference has been corrected from freezed: to freezed:freezed:, matching the fully qualified builder identifier used by the Dart/Flutter build system. This is consistent with the namespace update applied throughout the repository's example configurations and documentation.

packages/freezed/README.md (1)

828-828: Documentation updated: builder namespace corrected in three configuration examples.

The primary README documentation has been updated at three key locations (lines 828, 915, and 1361) to show freezed:freezed: as the correct builder identifier in build.yaml configuration examples. These examples cover union type customization, generic argument factories, and general configuration scenarios. The updates are consistent with the corrected namespace and provide accurate guidance to users.

Also applies to: 915-915, 1361-1361

resources/translations/ko_KR/README.md (1)

720-720: Translation maintained: builder namespace updated consistently in Korean documentation.

The Korean README translation has been updated in parallel with the English version at the corresponding configuration example sections (lines 720, 805, 1132). The builder identifier now correctly shows freezed:freezed: across all YAML examples. Translation consistency is maintained with the English documentation updates.

Also applies to: 805-805, 1132-1132

resources/translations/zh_CN/README.md (1)

713-713: Translation updated: builder namespace corrected in Simplified Chinese documentation.

The Simplified Chinese README translation has been synchronized with the English and other translations, updating the builder identifier to freezed:freezed: at the three primary configuration example sections (lines 713, 797, 1125). Translation consistency is maintained across all locales.

Also applies to: 797-797, 1125-1125

resources/translations/vi_VN/README.md (1)

712-712: Translation updated: builder namespace aligned in Vietnamese documentation.

The Vietnamese README translation has been updated with the correct builder identifier freezed:freezed: across the three configuration example sections (lines 712, 794, 1123). Consistency is maintained with English and other language translations of the documentation.

Also applies to: 794-794, 1123-1123

resources/translations/ja_JP/README.md (1)

724-724: Translation updated: builder namespace corrected in Japanese documentation.

The Japanese README translation has been updated consistently with other localizations, showing freezed:freezed: as the correct builder identifier in the three primary configuration example sections (lines 724, 808, 1145). All translations now reflect the accurate namespace specification.

Also applies to: 808-808, 1145-1145

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[build.yaml options] README says freezed: but should be freezed:freezed

1 participant

@arowolojoshuao